Improve the output of the debugger by jkyang92 · Pull Request #4365 · Macaulay2/M2

jkyang92 · 2026-05-24T06:55:23Z

This is a draft pull request improving the output of the current line of code in the debugger.

This pull request contains work with @adamlaclair @BrysonKagy @OlaPeteru from the Building the Future of Macaualy2 workshop. Comments welcome, I will still read through this to make sure that nothing is missing and no obvious issues remain.

These commits do not include any AI generated code.

@adamlaclair @BrysonKagy, Can you respond verifying that that the code from your commits can be distributed under GPL2+? (or the public domain or other compatible license if that is not acceptable)

…bugger, changed the input line indicates we are in the debugger from iine to <M2 Debugger>, and we added carets below the specific characters causing an error.

…function code'', adds carets for single line errors, and adds carets on first and last characters for multiple line outputs.

…Currently, this is not changeable by the user. We, also cleaned up the code.

…hich are available to the function code.

…e numbers.

…umbers.

…r-output

d-torrance · 2026-05-24T11:29:23Z

+code Function   := opt -> f -> codeFunction(null, f, 0)
+code Command    := opt -> C -> code C#0
+code List       := opt -> L -> DIV between_(HR{}) dedupMethods apply(L, code)
+code ZZ         := opt -> i -> code previousMethodsFound#i


Suggested change

code ZZ := opt -> i -> code previousMethodsFound#i

code ZZ := opt -> i -> code(previousMethodsFound#i, opt)

code(TestInput) in testing.m2 also needs updated to use options

Ah I'm afraid this is going to mess up code for hooks, e.g.:

i3 : code(syz, Matrix, Strategy => Default) o3 = -- code for strategy: syz(Matrix,Strategy => Default) ../linuxbrew/.linuxbrew/Cellar/macaulay2/1.26.05/share/Macaulay2/Core/ matrix2.m2:315:44-321:6: --source code: addHook((syz, Matrix), Strategy => Default, (opts, f) -> ( if not isFreeModule target f or not isFreeModule source f then error "expected map between free modules"; if ring f === ZZ or not isHomogeneous f then syz gb (f, opts, Syzygies=>true) else mingens image syz gb (f, opts, Syzygies=>true) ))

That's going to be a hard issue to fix cleanly, given this issue, I'm leaning towards just using the global to control the formating. It's a bit unfortunate, because the downside of the new output is it's hard to copy paste.

d-torrance · 2026-05-24T11:32:28Z

+
+
+protect PrintCaret
+protect PrintLineNum


I'm wondering if we should export these, too, so users can pass them to code? If so, then I'd considering using PrintCarets and PrintLineNumbers to match the corresponding debug-prefixed global variables.

We'd also need to update the code docs accordingly.

d-torrance · 2026-05-24T11:33:47Z

@@ -0,0 +1,29 @@
+


Was adding this file just a git oopsie?

d-torrance · 2026-05-24T11:55:40Z

 	  file = lines file;
 	  if #file < stop then error("line number ",toString stop, " not found in file ", filename);
-	  DIV splice { codeAddress(x), codeContent(start, stop, file) }
+	  DIV splice { codeAddress(x), codeContent(PrintCaret => debugPrintCarets, PrintLineNum => debugPrintLineNumbers, x, start, stop, file) }


It seems like we should use opt here. Maybe the default values should be null, and if so, use the global variables?

Either that or just drop options entirely and use the global variables inside codeContent?

BrysonKagy · 2026-05-27T20:27:07Z

@jkyang92 Yes I am ok with the work being distributed under GPL2+

mahrud · 2026-05-28T00:44:07Z

+--	  ZZ#{Standard,InputPrompt} = lineno -> concatenate(newline, lastprompt = concatenate(interpreterDepth:"i", toString lineno, " : "));
+
+	  ZZ#{Standard,InputPrompt} = lineno -> concatenate(newline, lastprompt = if (interpreterDepth == 1) then concatenate(interpreterDepth:"i", toString lineno, " : ") else concatenate("<M2 Debugger> ", interpreterDepth:"i", toString lineno, " : "));
+--	  if interpreterDepth > 0 then (
+--	      ZZ#{Standard,InputPrompt} = lineno -> concatenate("<M2 Debugger> ",lastprompt);
+--	  );


Could we make the prompt a little shorter? Maybe just <debugger> iiNN : for instance?

Also the commented lines should be removed.

Suggested change

-- ZZ#{Standard,InputPrompt} = lineno -> concatenate(newline, lastprompt = concatenate(interpreterDepth:"i", toString lineno, " : "));

ZZ#{Standard,InputPrompt} = lineno -> concatenate(newline, lastprompt = if (interpreterDepth == 1) then concatenate(interpreterDepth:"i", toString lineno, " : ") else concatenate("<M2 Debugger> ", interpreterDepth:"i", toString lineno, " : "));

-- if interpreterDepth > 0 then (

-- ZZ#{Standard,InputPrompt} = lineno -> concatenate("<M2 Debugger> ",lastprompt);

-- );

ZZ#{Standard,InputPrompt} = lineno -> concatenate(newline,

lastprompt = concatenate(if interpreterDepth == 1 then "<debugger> ", interpreterDepth:"i", toString lineno, " : ");

mahrud · 2026-05-28T00:45:46Z

       oldDebuggerCode := getGlobalVariable(currentS);
       setGlobalVariable(currentS,Expr(PseudocodeClosure(f,c)));
-	 printMessage(codePosition(c), "entering debugger (enter 'help' to see commands)");
+	 printMessage(codePosition(c), "\n"+ "ENTERING DEBUGGER (enter 'help' to see commands, enter 'break' to quit the debugger)");


Is it possible to make this print only once?

+1

I remember being surprised by this at the demo in Atlanta

mahrud · 2026-05-28T00:47:19Z

    "However, the following attempt results in an error, and the debugger starts up automatically.",
    EXAMPLE "g 2",
-    "You may use ", TO "help", ", as instructed, to view the commands available in the debugger.
+    "Here it says ENTERING DEBUGGER when you enter the deugger. You may use ", TO "help", ", as instructed, to view the commands available in the debugger.


Typo: deugger

adamlaclair and others added 14 commits May 18, 2026 14:47

Added message indicating entering the debugger and how to exit the de…

884e9f9

…bugger, changed the input line indicates we are in the debugger from iine to <M2 Debugger>, and we added carets below the specific characters causing an error.

Added number lines on error messages, also adds number lines for the …

796a834

…function code'', adds carets for single line errors, and adds carets on first and last characters for multiple line outputs.

Add toggle variable to turn printing line numbers / varets on / off. …

2775f47

…Currently, this is not changeable by the user. We, also cleaned up the code.

added documentation for debugger changes

4ac672d

Added global variables for toggling printing carets / line numbers, w…

49a2121

…hich are available to the function code.

Exported the global variables responsible for printing carets and lin…

6125ed2

…e numbers.

Removed unneccessary comments.

320b92e

Adding test file for new debugging output of printing carets / line n…

a9a874a

…umbers.

Merge branch 'debugger-output' of github.com:jkyang92/M2 into debugge…

1689c85

…r-output

added documentation for toggling printlines and printcarets off

fc67e55

Added comments above codeContent describing all of our changes

ab696cb

Fixed spelling

6c0774f

Added comments to codeContent.

bc7e3a8

Added comments. Made changes that Jay suggested.

37ddad9

jkyang92 changed the title ~~Debugger output~~ Improve the output of the debugger May 24, 2026

d-torrance requested changes May 24, 2026

View reviewed changes

Comment thread M2/Macaulay2/m2/test.m2

@@ -0,0 +1,29 @@

Copy link
Copy Markdown

Member

d-torrance May 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was adding this file just a git oopsie?

d-torrance requested changes May 24, 2026

View reviewed changes

d-torrance added Core Issues involving the Core scripts. Interpreter labels May 25, 2026

mahrud reviewed May 28, 2026

View reviewed changes

d-torrance added the M2@GT26 Project from the "Future of Macaulay2" workshop at Georgia Tech in May 2026 label May 28, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve the output of the debugger#4365

Improve the output of the debugger#4365
jkyang92 wants to merge 14 commits into
Macaulay2:developmentfrom
jkyang92:debugger-output

jkyang92 commented May 24, 2026

Uh oh!

d-torrance May 24, 2026

Uh oh!

mahrud May 28, 2026

Uh oh!

jkyang92 May 28, 2026

Uh oh!

d-torrance May 24, 2026

Uh oh!

d-torrance May 24, 2026

Uh oh!

d-torrance May 24, 2026

Uh oh!

BrysonKagy commented May 27, 2026

Uh oh!

mahrud May 28, 2026

Uh oh!

mahrud May 28, 2026

Uh oh!

d-torrance May 28, 2026

Uh oh!

mahrud May 28, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

	code ZZ := opt -> i -> code previousMethodsFound#i
	code ZZ := opt -> i -> code(previousMethodsFound#i, opt)



		protect PrintCaret
		protect PrintLineNum

Conversation

jkyang92 commented May 24, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BrysonKagy commented May 27, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants